<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="IMetaReader,com.metaphile.IMetaReader,autoClose,autoLimit,onMetaData,read" name="keywords">
<title>com.metaphile.IMetaReader</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IMetaReader - Metaphile API Documentation';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">Metaphile API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?com/metaphile/IMetaReader.html&amp;com/metaphile/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Interface&nbsp;IMetaReader</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IMetaReader"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.metaphile</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IMetaReader</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Implementors</td><td><a href="id3/ID3Reader.html">ID3Reader</a>, <a href="../metaphile/MetaReader.html">MetaReader</a>, <a href="mov/MOVReader.html">MOVReader</a>, <a href="swf/SWFReader.html">SWFReader</a></td>
</tr>
</table>
<p></p>
  Defines the interface that metadata parsers must conform to for inclusion in the metaphile library.
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#autoClose">autoClose</a> : Boolean<div class="summaryTableDescription">
   Determines if a stream is automatically closed after parsing or if it is left open for further use.</div>
</td><td class="summaryTableOwnerCol">IMetaReader</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#autoLimit">autoLimit</a> : int<div class="summaryTableDescription">
   Defines the maximum number of bytes to parse from a stream.</div>
</td><td class="summaryTableOwnerCol">IMetaReader</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#onMetaData">onMetaData</a> : Function<div class="summaryTableDescription">
   Defines a callback function which is called when metadata has been returned from a parser.</div>
</td><td class="summaryTableOwnerCol">IMetaReader</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#read()">read</a>(stream:IDataInput):void</div>
<div class="summaryTableDescription">
   Parses an open stream for metadata.</div>
</td><td class="summaryTableOwnerCol">IMetaReader</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="autoClose"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">autoClose</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>autoClose:Boolean</code>&nbsp;&nbsp;[read-write]<p>
   Determines if a stream is automatically closed after parsing or if it is left open for further use.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get autoClose():Boolean</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set autoClose(value:Boolean):void</code>
<br>
</div>
<a name="autoLimit"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">autoLimit</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>autoLimit:int</code>&nbsp;&nbsp;[read-write]<p>
   Defines the maximum number of bytes to parse from a stream.
   Some metadata formats store information at various points in a file. This limit will prevent the parser from loading large files which may have metadata at the end.
   If autoClose is set to true, the stream will be closed after reaching this limit.
   If any metadata has been retrieved before the limit was reached, onComplete will still be called.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get autoLimit():int</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set autoLimit(value:int):void</code>
<br>
</div>
<a name="onMetaData"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onMetaData</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>onMetaData:Function</code>&nbsp;&nbsp;[read-write]<p>
   Defines a callback function which is called when metadata has been returned from a parser.
   The callback function must take IMetaData as it's first argument.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get onMetaData():Function</code>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function set onMetaData(value:Function):void</code>
<br>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="read()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">read</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function read(stream:IDataInput):void</code><p>
   Parses an open stream for metadata.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">stream</span>:IDataInput</code></td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">This work is licensed under a Creative Commons Attribution 3.0 License.</center>
</div>
</body>
</html>
<!--This work is licensed under a Creative Commons Attribution 3.0 License.-->
